Add documentation for credHelper #950
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@TomSweeneyRedHat PTAL |
rhatdan
reviewed
Jun 4, 2020
docs/containers-auth.json.5.md
Outdated
| } | ||
| ``` | ||
|
|
||
| For more information on Docker credential stores, please reference the [GitHub docker-credential-helpers project](https://github.com/docker/docker-credential-helpers/releases). |
There was a problem hiding this comment.
Are these credential helpers not Stores and remove the extra Docker adjective.
For more information on credential helpers see: GitHub docker-credential-helpers project.
rhatdan
reviewed
Jun 4, 2020
docs/containers-auth.json.5.md
Outdated
| # SEE ALSO | ||
| buildah-login(1), buildah-logout(1), podman-login(1), podman-logout(1) | ||
| buildah-login(1), buildah-logout(1), podman-login(1), podman-logout(1), , skopeo-login(1), skopeo-logout(1) |
|
@TomSweeneyRedHat PTAL |
docs/containers-auth.json.5.md
Outdated
| provided by `login`. If the credential helpers are configured for specific registries, the base64 encoded will not be used | ||
| for operations concerning credentials of the specified registries. | ||
|
|
||
| When the credential helper is in use on a Linux platform, the auth.json file would contain keys specify the registry domain, and values specify the suffix of the program to use (i.e. everything after docker-credential-). For example: |
There was a problem hiding this comment.
Suggested change
| When the credential helper is in use on a Linux platform, the auth.json file would contain keys specify the registry domain, and values specify the suffix of the program to use (i.e. everything after docker-credential-). For example: | |
| When the credential helper is in use on a Linux platform, the auth.json file would contain keys that specify the registry domain, and values that specify the suffix of the program to use (i.e. everything after docker-credential). For example: |
Is there supposed to be a dash at the end of docker-credential- in the parens at the end? I removed it in my suggestion.
There was a problem hiding this comment.
there should be a dash at the end, the api will append the config value to this string to look for binary.
|
LGTM |
docs/containers-auth.json.5.md
Outdated
| @@ -37,8 +37,28 @@ their accounts on quay.io and docker.io: | |||
| An entry can be removed by using a `logout` command from a container | |||
| tool such as `podman logout` or `buildah logout`. | |||
|
|
|||
| In addition, credential helpers can be configured for specific registries and the credentials-helper | |||
| software can be used to manage the credentials in a more secure way than depending on the base64 encoded authentication | |||
| provided by `login`. If the credential helpers are configured for specific registries, the base64 encoded will not be used | |||
There was a problem hiding this comment.
Sorry, missed this last time!
Suggested change
| provided by `login`. If the credential helpers are configured for specific registries, the base64 encoded will not be used | |
| provided by `login`. If the credential helpers are configured for specific registries, the base64 encoded authentication will not be used |
Add documentation for credHelper. Close containers/podman#1675 Signed-off-by: Qi Wang <[email protected]>
|
LGTM |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documentation for credHelper. Close containers/podman#1675
Signed-off-by: Qi Wang [email protected]